<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<title>proDOC : : how to describe your library</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<style type="text/css">
<!--
body {
	margin-left: 0px;
	margin-top: 0px;
	margin-right: 0px;
	margin-bottom: 0px;
	background-color: #FFFFFF;
}
A:link {
	color: #000000;
	text-decoration: none
}
A:visited {
	color: #000000;
	text-decoration: none
}											
A:active {
	color: #999900; 
	text-decoration: none
}
A:hover {
	color: #999900;
	text-decoration: none;
}
-->
</style>
<link href="stylesheet.css" rel="stylesheet" type="text/css">
</head>
<body>
<center>
<table width="600" border="0" cellspacing="0" cellpadding="0">
  <tr>
    <td width="75" height="100" valign="top" class="header"><img src="images/prodoc.gif" width="127" height="40"><br>
        <img src="images/index.gif" width="91" height="50" border="0" usemap="#MapMap"></td>
    <td width="450" class="descList">&nbsp;</td>
  </tr>
  <tr>
    <td valign="top" class="mainTextName">Name</td>
    <td class="methodName">How to describe your library </td>
  </tr>
  <tr>
    <td valign=top class="mainText">&nbsp;</td>
    <td valign=top class="descList"> You have to describe your library in a package.htm file that has to be put into the package of your library. If the the name of the lib differs from the name of the package you can insert the @libname tag followed by the name of the lib. <br>
      <br>
      To work with proDOC you have to supply a certain file structure. This is important so that proDOC can find all needed ressources. Here is an example sheme. </td>
  </tr>
  <tr>
    <td valign=top class="mainText">filestructure</td>
    <td valign=top class="descList"><pre class="codeexample">c:\path\to\your\lib<br>c:\path\to\your\lib\libpackage<br>c:\path\to\your\lib\libpackage\source1.java<br>c:\path\to\your\lib\libpackage\source2.java
...<br>c:\path\to\your\lib\libpackage\sourcen.java<br>c:\path\to\your\lib\examples<br>c:\path\to\your\lib\examples\example1
c:\path\to\your\lib\examples\example1\example1.pde<br>c:\path\to\your\lib\examples\example2
c:\path\to\your\lib\examples\example2\example2.pde<br>...<br>c:\path\to\your\lib\examples\examplen
c:\path\to\your\lib\examples\examplen\examplen.pde<br>c:\path\to\your\lib\templates\<br>c:\path\to\your\lib\templates\class.htm<br>c:\path\to\your\lib\templates\classmember.htm<br>c:\path\to\your\lib\templates\classmembers.htm<br>c:\path\to\your\lib\templates\index.htm<br>c:\path\to\your\lib\templates\member.htm<br>c:\path\to\your\lib\templates\memberparameter.htm<br>c:\path\to\your\lib\templates\memberparameters.htm<br>c:\path\to\your\lib\templates\memberreturn.htm<br>c:\path\to\your\lib\templates\stylesheet.css<br>c:\path\to\your\lib\templates\images<br>c:\path\to\your\lib\templates\images\image1.gif<br>c:\path\to\your\lib\templates\images\image2.gif<br>...<br>c:\path\to\your\lib\templates\images\imagen.gif
    </pre></td>
  </tr>
  <tr>
    <td valign=top class="mainText">&nbsp;</td>
    <td valign=top class="descList">The documentation is put into a folder documentation placed in your lib folder. All images in your template folder and the stylesheet.css file are copied to this location. </td>
  </tr>
  <tr>
    <td valign=top class="mainText">package.html</td>
    <td valign=top class="descList"><pre class="codeexample">&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01 Transitional//EN&quot;<br>&quot;http://www.w3.org/TR/html4/loose.dtd&quot;&gt;<br>&lt;html&gt;<br>&lt;head&gt;<br>&lt;title&gt;packagehtml&lt;/title&gt;<br>&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=iso-8859-1&quot;&gt;<br>&lt;/head&gt;<br>&lt;body&gt;<br>The proXML library allows Processing to read and write XML files. You can build <br>a XML document by putting together different elements, or you can open an XML element <br>form a certain url. When you have the XML-element filled with content you can save it<br>as XML document.&lt;br&gt;<br>&lt;br&gt;<br>The parser of proXML mainly bases on the html parser of proHTML. It takes a XML Document <br>and parses it into a tree structure.<br>&lt;br&gt;<br>@libname proXML <br>&lt;/body&gt;<br>&lt;/html&gt;</pre></td>
  </tr>
  <tr>
    <td><img src="video/images/1pix.gif" width="1" height="25"></td>
    <td class="descList">As youcan see there is line @libname proXML. This is a first example of using tags with proDOC. There exist required tags and a few optional tags. Note that a tag can be optional in the sourcecode comments but required in the html template and vice versa. There are tags that are used for templates, tags that are used for comments and tags that are used for both. <br>
        <br>
      For the library comments in package.html there only exists the tag @libname. It is optional in both comment and template. Here is the source code of the standard template for the index page of a libdoc:</td>
  </tr><tr>
    <td valign=top class="mainText">index.html</td>
    <td valign=top class="descList"><pre class="codeexample">&lt;!DOCTYPE HTML PUBLIC &quot;-//W3C//DTD HTML 4.01 Transitional//EN&quot;<br>&quot;http://www.w3.org/TR/html4/loose.dtd&quot;&gt;<br>&lt;html&gt;<br>&lt;head&gt;<br>&lt;title&gt;@title&lt;/title&gt;<br>&lt;meta http-equiv=&quot;Content-Type&quot; content=&quot;text/html; charset=iso-8859-1&quot;&gt;<br>&lt;link href=&quot;stylesheet.css&quot; rel=&quot;stylesheet&quot; type=&quot;text/css&quot;&gt;<br>&lt;/head&gt;<br>&lt;body&gt;<br>&lt;center&gt;<br>&lt;table width=&quot;600&quot; height=&quot;100%&quot;  border=&quot;0&quot; cellpadding=&quot;0&quot; cellspacing=&quot;0&quot;&gt;<br>  &lt;tr&gt;<br>    &lt;td width=&quot;400&quot; height=&quot;100&quot; valign=&quot;top&quot; class=&quot;indexheader&quot;&gt;@libname&lt;/td&gt;<br>    &lt;td class=&quot;linkList&quot;&gt;&amp;nbsp;&lt;/td&gt;<br>  &lt;/tr&gt;<br>  &lt;tr&gt;<br>    &lt;td class=&quot;indextext&quot;&gt; indexdescription&lt;/td&gt;<br>    &lt;td class=&quot;descList&quot;&gt;indexlinks&lt;/td&gt;<br>  &lt;/tr&gt;<br>&lt;/table&gt;<br>&lt;/center&gt;<br>&lt;/body&gt;<br>&lt;/html&gt;</pre></td>
  </tr>
  <tr>
    <td><img src="video/images/1pix.gif" width="1" height="25"></td>
    <td class="descList">When you provide you own template files, the index template requires three tags. The first is @title to insert a title into your later docfile. Second comes  @description, working as placeholder for the description of your library, that has to be included in the package.html file, the third one is @links which is a placeholder for the links to the different classes, methods and fields. <br>
      <br>
      For the linklist proDOC generates a headline for every class of your lib and than puts the  links to the description of their methods and fields after it. @libname is an optional tag you can use it to have a headline for you documentation, but you could also use an image instead. </td>
  </tr>
  <tr>
    <td><img src="video/images/1pix.gif" width="1" height="25"></td>
    <td class="descList">&nbsp;</td>
  </tr>
</table>
<br>
<br>
<br>
<br>
</center>
<map name="MapMap">
  <area shape="rect" coords="3,13,88,34" href="index.html">
</map>
</body>
</html>
